/*
 * Copyright 2023 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package androidx.compose.runtime.snapshots

/**
 * Designates a function as a factory function that produces a State object. Since State factory
 * functions create and initialize a state, they should usually only be called once per state value
 * initialization. This annotation causes all invocations of marked state factory functions to be
 * checked to ensure that they are not called directly inside the body of a [Composable] function
 * and are instead wrapped with an appropriate [remember] call.
 */
@MustBeDocumented
@Target(AnnotationTarget.FUNCTION)
@Retention(AnnotationRetention.BINARY)
annotation class StateFactoryMarker
